feat: Add protect & unprotect workunit to WU context menu #367

dehilsterlexis · 2023-12-13T19:54:08Z

This will require the adding of two functions to the Workunit class in the comms code in the Visualization repository: https://github.com/hpcc-systems/Visualization/blob/trunk/packages/comms/src/ecl/workunit.ts

dehilsterlexis · 2023-12-13T19:54:25Z

@GordonSmith for review

GordonSmith

Have you opened a PR or Ticket for the Viz repo?

Can you remove the submenu and only show "Protect" when WU is not protected and show "Unprotect" when the WU is protected?

dehilsterlexis · 2023-12-14T14:15:04Z

I did create a ticket (not an issue) for this.

dehilsterlexis · 2023-12-14T15:14:51Z

@GordonSmith will make the changes you requested.

dehilsterlexis · 2023-12-14T17:17:56Z

@GordonSmith come to think of it, I don't believe you can dynamically change the menu. You can only gray things out. So I suggest we gray the appropriate one out.

GordonSmith · 2023-12-15T09:46:56Z

It is a little bit tricky - but if you search the code base for:

hpccPlatform.isAllWorkunits
hpccPlatform.isMyWorkunits

You can see how I worked around the limitation.

dehilsterlexis · 2023-12-15T16:57:28Z

@GordonSmith the setContext command is a global command and works in the case of isAllWorkunits and isMyWorkunits because they are globals that pertain to all tree nodes. The protect only applies to a single node so it can't be used in the same way. It will have to be grayed out using viewItem because viewItem is specific to each tree node.

GordonSmith · 2023-12-15T17:06:06Z

Sounds plausible.

GordonSmith · 2024-01-08T10:19:11Z

@dehilsterlexis you need to

Bump the version of @hpcc-js/comms in the package.json
Run npm install
Commit package.json + package-lock.json

dehilsterlexis · 2024-01-08T13:59:17Z

@GordonSmith for review

GordonSmith · 2024-01-09T14:30:12Z

src/ecl/eclWatchTree.ts

@@ -93,6 +93,16 @@ export class ECLWatchTree extends Tree {
            wuNode.delete();
        });

+        vscode.commands.registerCommand("hpccPlatform.protectWU", (wuNode: ECLWUNode) => {
+            wuNode.protect();
+            this.refresh();


Not sure this refresh is needed? If it is, it should wait for the "protect" to complete?

Yes, you need it or the menu doesn't update.

Remove this.refresh here.

GordonSmith · 2024-01-09T14:30:22Z

src/ecl/eclWatchTree.ts

+
+        vscode.commands.registerCommand("hpccPlatform.unprotectWU", (wuNode: ECLWUNode) => {
+            wuNode.unprotect();
+            this.refresh();


Not sure this refresh is needed? If it is, it should wait for the "unprotect" to complete?

Yes, you need it or the menu doesn't update.

Remove this.refresh here.

GordonSmith · 2024-01-09T14:31:02Z

src/ecl/eclWatchTree.ts

+    }
+
+    unprotect() {
+        this._wu.unprotect();


Should refresh the tree?

No, that would call it twice.

Change to:

this._wu.unprotect().then(() => this._tree.refresh());

src/ecl/eclWatchTree.ts

GordonSmith · 2024-01-09T14:34:12Z

src/ecl/eclWatchTree.ts

@@ -421,7 +439,8 @@ export class ECLWUNode extends Item<ECLWatchTree> {
    }

    contextValue(): string {
-        return this._wu.isComplete() ? "ECLWUNodeComplete" : "ECLWUNode";
+        const prot = this._wu.Protected ? "Protected" : "Unprotected";


Change to ECLWUNodeProtected and ECLWUNode respectivly.

The reasons for this change:

Consistency

Avoid a context clash with other extensions (not very likely, but...)

src/ecl/eclWatchTree.ts

GordonSmith

Also update ECLWUNode.getLabel to

    getLabel(): string {
        let primary = this._wu.Wuid;
        const extras: string[] = [];
        if (!this._wu.isComplete() || this._wu.isDeleted()) extras.push(this._wu.State);
        if (!this._tree._myWorkunits && this._wu.Owner) extras.push(this._wu.Owner);
        if (this._wu.Jobname) {
            primary = this._wu.Jobname;
            extras.push(this._wu.Wuid);
        }
        if (this._wu.Protected) {
            extras.push("Protected");
        }
        return extras.length ? `${primary} (${extras.join(", ")})` : primary;
    }

And / or update the icon to show the lock symbol?

GordonSmith · 2024-01-19T10:53:29Z

src/ecl/eclWatchTree.ts

@@ -93,6 +93,16 @@ export class ECLWatchTree extends Tree {
            wuNode.delete();
        });

+        vscode.commands.registerCommand("hpccPlatform.protectWU", (wuNode: ECLWUNode) => {
+            wuNode.protect();
+            this.refresh();


Remove this.refresh here.

GordonSmith · 2024-01-19T10:53:46Z

src/ecl/eclWatchTree.ts

+
+        vscode.commands.registerCommand("hpccPlatform.unprotectWU", (wuNode: ECLWUNode) => {
+            wuNode.unprotect();
+            this.refresh();


Remove this.refresh here.

src/ecl/eclWatchTree.ts

GordonSmith · 2024-01-19T10:54:39Z

src/ecl/eclWatchTree.ts

+    }
+
+    unprotect() {
+        this._wu.unprotect();


Change to:

this._wu.unprotect().then(() => this._tree.refresh());

GordonSmith · 2024-01-19T10:54:52Z

src/ecl/eclWatchTree.ts

@@ -421,7 +439,8 @@ export class ECLWUNode extends Item<ECLWatchTree> {
    }

    contextValue(): string {
-        return this._wu.isComplete() ? "ECLWUNodeComplete" : "ECLWUNode";
+        const prot = this._wu.Protected ? "Protected" : "Unprotected";


GordonSmith · 2024-01-22T15:03:34Z

src/ecl/eclWatchTree.ts

@@ -421,7 +439,8 @@ export class ECLWUNode extends Item<ECLWatchTree> {
    }

    contextValue(): string {
-        return this._wu.isComplete() ? "ECLWUNodeComplete" : "ECLWUNode";
+        const prot = this._wu.Protected ? "Protected" : "Unprotected";


The reasons for this change:

Consistency

Avoid a context clash with other extensions (not very likely, but...)

dehilsterlexis · 2024-01-23T19:04:03Z

@GordonSmith for review. The caret in the when clause does not seem to work in this particular when clauses so ECLWUNodeUnprotected was used.

GordonSmith

See the comment WRT to getLabel.

dehilsterlexis · 2024-01-24T15:45:25Z

@GordonSmith for review

dehilsterlexis · 2024-01-24T15:48:58Z

@GordonSmith this is most likely failing because of a version problem. Any suggestions?

GordonSmith · 2024-01-24T16:19:06Z

You need to:

npm install

And then commit both the package-lock.json and the package.json.

Did you test its working?

GordonSmith · 2024-01-25T12:51:57Z

PR tests failing...

dehilsterlexis · 2024-01-25T13:17:37Z

@GordonSmith yes I know. I can't seem to get rid of some files in the PR that should not be there. Usually this is fixed by rebasing.

dehilsterlexis · 2024-01-25T14:58:03Z

@GordonSmith for review

GordonSmith · 2024-01-26T09:06:07Z

package.json

+        "command": "hpccPlatform.protectWU",
+        "category": "ECL",
+        "title": "%Protect Workunit%",
+        "enablement": "viewItem =~ /ECLWUNodeComplete/"


I think its ok to protect a WU while its running?

GordonSmith · 2024-01-26T09:06:11Z

package.json

+        "command": "hpccPlatform.unprotectWU",
+        "category": "ECL",
+        "title": "%Unprotect Workunit%",
+        "enablement": "viewItem =~ /ECLWUNodeComplete/"


I think its ok to unprotect a WU while its running?

GordonSmith · 2024-01-26T09:12:45Z

src/ecl/eclWatchTree.ts

-
-    getDescription(): string {
-        return this._result.Value ?? "";
+        return `${this._result.Name}:  ${this._result.Value}`;
    }


I prefer the label + description approach.

src/ecl/eclWatchTree.ts

GordonSmith

WU Can be protected / unprotected while running

GordonSmith · 2024-02-09T09:56:40Z

@dehilsterlexis some comments and needs a rebase.

dehilsterlexis · 2024-02-13T14:44:31Z

@GordonSmith for review

GordonSmith · 2024-02-14T08:22:06Z

package.json

+        "command": "hpccPlatform.protectWU",
+        "category": "ECL",
+        "title": "%Protect Workunit%",
+        "enablement": "viewItem =~ /ECLWUNodeComplete/"


I think its ok to protect a WU while its running?

GordonSmith

You should be able to protect and unprotect a WU before its completed.

Signed-off-by: David de Hilster <[email protected]>

ddehilster · 2024-02-19T15:08:48Z

@GordonSmith now functions before completed. For review.

GordonSmith requested changes Dec 14, 2023

View reviewed changes

dehilsterlexis force-pushed the ADD_PROTECT branch 3 times, most recently from 04d60d5 to d56fad6 Compare January 4, 2024 22:13

dehilsterlexis force-pushed the ADD_PROTECT branch from d56fad6 to 911bd36 Compare January 8, 2024 13:55

GordonSmith self-requested a review January 9, 2024 14:27

GordonSmith requested changes Jan 9, 2024

View reviewed changes

dehilsterlexis force-pushed the ADD_PROTECT branch from 911bd36 to 77b7628 Compare January 9, 2024 14:54

GordonSmith requested changes Jan 19, 2024

View reviewed changes

dehilsterlexis force-pushed the ADD_PROTECT branch from 77b7628 to ae99d35 Compare January 19, 2024 18:26

GordonSmith requested changes Jan 22, 2024

View reviewed changes

dehilsterlexis force-pushed the ADD_PROTECT branch from ae99d35 to b9c0924 Compare January 23, 2024 18:57

GordonSmith approved these changes Jan 24, 2024

View reviewed changes

GordonSmith requested changes Jan 24, 2024

View reviewed changes

dehilsterlexis force-pushed the ADD_PROTECT branch from b9c0924 to d3de696 Compare January 24, 2024 15:02

dehilsterlexis force-pushed the ADD_PROTECT branch 2 times, most recently from 3adb820 to 6abd006 Compare January 24, 2024 18:06

dehilsterlexis force-pushed the ADD_PROTECT branch 4 times, most recently from 39a2571 to 938114e Compare January 24, 2024 18:23

dehilsterlexis force-pushed the ADD_PROTECT branch 3 times, most recently from 5cea82a to 0b98c93 Compare January 25, 2024 14:52

GordonSmith requested changes Jan 26, 2024

View reviewed changes

dehilsterlexis force-pushed the ADD_PROTECT branch 3 times, most recently from d44f957 to b30e763 Compare January 26, 2024 16:40

GordonSmith requested changes Feb 6, 2024

View reviewed changes

dehilsterlexis force-pushed the ADD_PROTECT branch 2 times, most recently from 4cf6813 to 088c789 Compare February 13, 2024 14:41

GordonSmith requested changes Feb 14, 2024

View reviewed changes

dehilsterlexis force-pushed the ADD_PROTECT branch from 088c789 to a425c86 Compare February 16, 2024 15:57

GordonSmith requested changes Feb 16, 2024

View reviewed changes

feat: Add protect & unprotect workunit to WU context menu

a249bf3

Signed-off-by: David de Hilster <[email protected]>

dehilsterlexis force-pushed the ADD_PROTECT branch from a425c86 to a249bf3 Compare February 19, 2024 14:24

GordonSmith approved these changes Feb 19, 2024

View reviewed changes

GordonSmith merged commit d255624 into hpcc-systems:trunk Feb 19, 2024
1 check passed

dehilsterlexis mentioned this pull request Feb 20, 2024

Add Protect and Unprotect to Workunit context menu #366

Closed

feat: Add protect & unprotect workunit to WU context menu #367

feat: Add protect & unprotect workunit to WU context menu #367

Conversation

dehilsterlexis commented Dec 13, 2023

dehilsterlexis commented Dec 13, 2023

GordonSmith left a comment

Choose a reason for hiding this comment

dehilsterlexis commented Dec 14, 2023

dehilsterlexis commented Dec 14, 2023

dehilsterlexis commented Dec 14, 2023

GordonSmith commented Dec 15, 2023 • edited Loading

dehilsterlexis commented Dec 15, 2023

GordonSmith commented Dec 15, 2023

GordonSmith commented Jan 8, 2024

dehilsterlexis commented Jan 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GordonSmith left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dehilsterlexis commented Jan 23, 2024 • edited Loading

GordonSmith left a comment

Choose a reason for hiding this comment

dehilsterlexis commented Jan 24, 2024

dehilsterlexis commented Jan 24, 2024

GordonSmith commented Jan 24, 2024

GordonSmith commented Jan 25, 2024

dehilsterlexis commented Jan 25, 2024 • edited Loading

dehilsterlexis commented Jan 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GordonSmith left a comment

Choose a reason for hiding this comment

GordonSmith commented Feb 9, 2024

dehilsterlexis commented Feb 13, 2024

Choose a reason for hiding this comment

GordonSmith left a comment

Choose a reason for hiding this comment

ddehilster commented Feb 19, 2024

GordonSmith commented Dec 15, 2023 •

edited

Loading

dehilsterlexis commented Jan 23, 2024 •

edited

Loading

dehilsterlexis commented Jan 25, 2024 •

edited

Loading